/*===========================================================================
  Copyright (C) 2011-2013 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  This library is free software; you can redistribute it and/or modify it 
  under the terms of the GNU Lesser General Public License as published by 
  the Free Software Foundation; either version 2.1 of the License, or (at 
  your option) any later version.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License 
  along with this library; if not, write to the Free Software Foundation, 
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package net.sf.okapi.lib.xliff2.core;

/**
 * Provides the methods to add and retrieve notes for an object. 
 */
public interface IWithNotes {

	/**
	 * Adds a note to the list of notes.
	 * @param note the note to add.
	 */
	public void addNote (Note note);
	
	/**
	 * Gets the {@link Notes} object for this object.
	 * @return the notes for this object.
	 * Never returns null.
	 */
	public Notes getNotes ();

	/**
	 * Gets the number of notes for this object.
	 * @return the number of notes available.
	 */
	public int getNoteCount ();

	/**
	 * Gets the note for a given fragment identifier or identifier in this object.
	 * @param fragIdOrId the fragment identifier (e.g. "#n=n1") or identifier (e.g. "n1").
	 * Allowing a fragment identifier is for convenience only: the full fragment may not be validated.
	 * @return the corresponding {@link Note} or null.
	 */
	public Note getNote (String fragIdOrId);

}
